-
Notifications
You must be signed in to change notification settings - Fork 170
Normative: Validate unit-valued options after all options are read #3130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3130 +/- ##
=======================================
Coverage 96.86% 96.86%
=======================================
Files 22 22
Lines 10081 10081
Branches 1824 1824
=======================================
Hits 9765 9765
Misses 267 267
Partials 49 49 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
70fa5fa
to
b3f6a0f
Compare
The code that changes behavior with this PR is something like: obj = {
get largestUnit() {
console.log("get largestUnit");
return "years";
},
get smallestUnit() {
console.log("get smallestUnit");
return "seconds";
},
}
Temporal.PlainTime.from("00:00").round(obj) Current behavior: console logs "get largestUnit" and then RangeError is thrown. New behavior: console logs both "get largestUnit" and "get smallestUnit", and then RangeError is thrown. Note: the RangeError is because PlainTime does not allow (as noted previously, there doesn't appear to be Test262 coverage for this) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intended changes as I understand them do seem both reasonable and narrow, but I think the algorithms steps fail to properly implement them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is roughly what I was imagining, thanks for doing all this work!
As Richard has noted, handling unset/default values may be tricky. The way I was expecting it to work was that the get allows you to specify REQUIRED, and Validate doesn't need to care, which roughly appears to be what you're doing here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm surprised that this didn't show up in more places. But I guess smallestUnit
is often the last option read anyway, because S is relatively late in the alphabet. So I'm pleasantly surprised at the small extent of the normative change. (I am assuming this PR is the full extent of the changes!)
All in all I'd still prefer not to do this. (It isn't a bug in the proposal, it sets a new precedent that TC39 hasn't really shown appetite for so far, and I just don't see the alternative workaround in temporal_rs as that big of a deal.) But it's small and targeted enough that if I'm the only opposing voice, I won't stand in the way.
Logistical note: to make the best impression when presenting to TC39, I'd recommend squashing the fixup commits into their appropriate editorial or normative commits, then splitting out the editorial commit into its own PR which I can review quickly and merge. That way, there's less for delegates to review and it's much clearer what is changing.
This PR fixes the issues involving unit-valued options, which is the current scope of the issue and all I'm asking for at this time. Yes, often smallestUnit is the final read, so no change was needed in those cases. Yes, splitting the editorial change into its own PR is something I'm happy to do. |
@anba Do you have any concerns about this change? |
I opened #3135 for the editorial changes. |
The editorial changes are merged, and I rebased this. So now it's just the minimal set of normative changes. |
I don't think so. It'll require some small refactoring because the current SM implementation sometimes uses (The SM implementation already parses the unit options accepting all units and only later check which units are actually allowed. ) |
I wonder is there a difference between "Get-Cast-Get-Cast-Validate" and "Get-Get-Cast-Cast-Validate" |
Yes, there is, the Get step may fail if the object has an accessor property, and the Cast step may fail if the property is of the wrong type, so it's observable. |
I'd like to write test262 tests for this before merging it, because it's not covered at all. To that end, it'd be helpful if #3142 could be reviewed and merged first, as it contains the updates to the reference code for the editorial changes. |
I'd like to know why you chose "Get-Cast-Get-Cast-Validate", not "Get-Get-Cast-Cast-Validate". Is there a difference between them when making a fast implementation? If there is no difference, "Get-Get-Cast-Cast-Validate" looks clearer to me. |
The thinking was that Get and Cast are both steps that deeply involve the JS bindings, a layer above the library boundary, whereas Validate is on the library layer. Also, the champions didn't want to make a large change, and Get Get Cast Cast would involve rewriting all call sites of GetOption. |
b226658
to
f60035a
Compare
These tests cover the normative change approved in the July 2025 TC39 plenary. See tc39/proposal-temporal#3130. All properties of user-passed options objects should be read and cast before any "algorithmic validation" is done. This is a lot of tests, that cover every entry point where an options object is passed in, where subsequently an exception can be thrown or user code can be called. However, the normative change only affects 10 of these tests: - Instant.p.since,until,toString - PlainDate.p.since,until - PlainTime.p.since,until - PlainYearMonth.p.since,until - ZonedDateTime.p.toString The other 35 tests simply close a gap in coverage.
These tests cover the normative change approved in the July 2025 TC39 plenary. See tc39/proposal-temporal#3130. All properties of user-passed options objects should be read and cast before any "algorithmic validation" is done. This is a lot of tests, that cover every entry point where an options object is passed in, where subsequently an exception can be thrown or user code can be called. However, the normative change only affects 10 of these tests: - Instant.p.since,until,toString - PlainDate.p.since,until - PlainTime.p.since,until - PlainYearMonth.p.since,until - ZonedDateTime.p.toString The other 35 tests simply close a gap in coverage.
I've written tests to cover this in tc39/test262#4557. Please check if the behaviour is as you expect. |
Is the handling of Auto correct here? @sffc I am trying to implement this, and I noted that GetTemporalUnitValuedOption unconditionally parses "auto", however no call for Validate has auto as extraValues, AND auto is not in the table, so AIUI Validate will always reject Auto. Probably a bug? |
We think that the only case where |
I don't think there's a bug? |
Ah! I was looking at calls to Validate, so I didn't notice there was a case without a call. Thanks! Might make a PR to add this to the description. |
There is one other call site of validate that permits auto, in |
I can verify that V8 updated to this PR passes those tests |
This updates to the non-observable changes from tc39/proposal-temporal#3135 This also makes the changes from to-be-merged spec PR tc39/proposal-temporal#3130 (these changes are observable) This passes the tests added in tc39/test262#4557. Bug: 401065166 Change-Id: I6a6a6964a2436085a3fa20b3bbb10392f0fe95df Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/6851756 Auto-Submit: Manish Goregaokar <[email protected]> Commit-Queue: Manish Goregaokar <[email protected]> Reviewed-by: Leszek Swirski <[email protected]> Cr-Commit-Position: refs/heads/main@{#101978}
These tests cover the normative change approved in the July 2025 TC39 plenary. See tc39/proposal-temporal#3130. All properties of user-passed options objects should be read and cast before any "algorithmic validation" is done. This is a lot of tests, that cover every entry point where an options object is passed in, where subsequently an exception can be thrown or user code can be called. However, the normative change only affects 10 of these tests: - Instant.p.since,until,toString - PlainDate.p.since,until - PlainTime.p.since,until - PlainYearMonth.p.since,until - ZonedDateTime.p.toString The other 35 tests simply close a gap in coverage.
These tests cover the normative change approved in the July 2025 TC39 plenary. See tc39/proposal-temporal#3130. All properties of user-passed options objects should be read and cast before any "algorithmic validation" is done. This is a lot of tests, that cover every entry point where an options object is passed in, where subsequently an exception can be thrown or user code can be called. However, the normative change only affects 10 of these tests: - Instant.p.since,until,toString - PlainDate.p.since,until - PlainTime.p.since,until - PlainYearMonth.p.since,until - ZonedDateTime.p.toString The other 35 tests simply close a gap in coverage.
It'll be easiest if I can get a review of #3145 before merging this one, because it's convenient to pull in updated test262 commits in order. |
See #3116
This preserves the original call to
GetOption
, but it always calls it with the full list of units, and I pull the subset-checking logic into a separate AO.I have two commits: an editorial change to split the AO in two, and a small normative change to move the validation later down at the call sites.
@nekevss @Manishearth